home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / opt / pinstaller / GLIUtility.py < prev    next >
Text File  |  2006-02-15  |  29KB  |  946 lines
  1. """
  2. # Copyright 1999-2005 Gentoo Foundation
  3. # This source code is distributed under the terms of version 2 of the GNU
  4. # General Public License as published by the Free Software Foundation, a copy
  5. # of which can be found in the main directory of this project.
  6. Gentoo Linux Installer
  7.  
  8. The GLIUtility module contians all utility functions used throughout GLI.
  9. """
  10.  
  11. import string, os, re, shutil, sys, random, commands, crypt, pty, select
  12. from GLIException import *
  13.  
  14. ##
  15. # Check to see if a string is actually a string, and if it is not null. Returns bool.
  16. # @param string_a    string to be checked.
  17. def is_realstring(string):
  18.     # Make sure it is a string
  19.     if not isinstance(string, (str, unicode)):
  20.         return False
  21.         
  22.     return True
  23.  
  24. ##
  25. # Checks to see if x is a numeral by doing a type conversion.
  26. # @param x   value to be checked
  27. def is_numeric(x):
  28.     try:
  29.         float(x)
  30.     except ValueError:
  31.         return False
  32.     else:
  33.         return True
  34.  
  35. ##
  36. # Check to see if a string is a valid ip. Returns bool.
  37. # @param ip     ip to be checked.
  38. def is_ip(ip):
  39.     # Make sure it is a string
  40.     if not is_realstring(ip):
  41.         return False
  42.  
  43.     # Compile the regular expression that validates an IP. It will also check for valid ranges.
  44.     expr = re.compile('(([0-9]|[01]?[0-9]{2}|2([0-4][0-9]|5[0-5]))\.){3}([0-9]|[01]?[0-9]{2}|2([0-4][0-9]|5[0-5]))$')
  45.  
  46.     # Run the test.
  47.     res = expr.match(ip)
  48.  
  49.     # Return True only if there are results.
  50.     return(res != None)
  51.  
  52. ##
  53. # Check to see if mac is a valid MAC address. Make sure use format_mac
  54. # before using this function. Returns bool.
  55. # @param mac   mac address to be checked.
  56. def is_mac(mac):
  57.     expr = re.compile('([0-9A-F]{2}:){5}[0-9A-F]{2}')
  58.     res = expr.match(mac)
  59.     return(res != None)
  60.  
  61. ##
  62. # Format's a mac address properly. Returns the correctly formatted MAC. (a string)
  63. # @param mac   mac address to be formatted
  64. def format_mac(mac):
  65.     mac = string.replace(mac, '-', ':')
  66.     mac = string.upper(mac)
  67.  
  68.     mac = string.split(mac, ':')
  69.     for i in range(0, len(mac)):
  70.         if len(mac[i]) < 2:
  71.             mac[i] = "0" + mac[i]
  72.     return string.join(mac, ":")
  73.  
  74. ##
  75. # Removes leading zero's from an IP address. For example
  76. # trim_ip('192.168.01.002') => '192.168.1.2'
  77. # @param ip  IP address to be trimmed
  78. def trim_ip(ip):
  79.     # Remove leading zero's on the first octet
  80.     ip = re.sub('^0{1,2}','',ip)
  81.  
  82.     # Remove leading zero's from the other octets
  83.     res = re.sub('((?<=\.)(00|0)(?P<num>\d))','\g<num>',ip)
  84.  
  85.     return(res)
  86.  
  87. ##
  88. # Check to see if the string passed is a valid device. Returns bool.
  89. # @param device    device to be checked
  90. def is_device(device):
  91.     # Make sure it is a string
  92.     if not is_realstring(device):
  93.         return False
  94.             
  95.     # Make sure the string starts with /dev/
  96.     if device[0:5] != '/dev/':
  97.         return False
  98.             
  99.     # Check to make sure the device exists
  100.     return os.access(device, os.F_OK)
  101.         
  102. ##
  103. # Check to see if the string is a valid hostname. Returns bool.
  104. # @param hostname   host to be checked
  105. def is_hostname(hostname):
  106.     # Make sure it is a string
  107.     if not is_realstring(hostname):
  108.         return False
  109.             
  110.     expr = re.compile('^([a-zA-Z0-9-_\.])+\.[a-zA-Z]{2,4}$')
  111.     res = expr.match(hostname)
  112.  
  113.     return(res != None)
  114.         
  115. ##
  116. # Check to see if the string is a valid path. Returns bool.
  117. # @param path     Path to be checked.
  118. def is_path(path):
  119.     # Make sure it is a string
  120.     if not is_realstring(path):
  121.         return False
  122.  
  123.     # Create a regular expression that matches all words and the symbols '-_./' _ is included in the \w
  124.     expr = re.compile('^[\w\.\-\/~]+$')
  125.  
  126.     # Run the match
  127.     res = expr.match(path)
  128.  
  129.     # Return True only if there are results
  130.     return(res != None)
  131.         
  132. ##
  133. # Check to see if the string is a valid file. Returns bool.
  134. # @param file  file to be checked for validity.
  135. def is_file(file):
  136.     # Make sure it is a string
  137.     if not is_realstring(file):
  138.         return False
  139.             
  140.     # Check to make sure the device exists
  141.     return os.access(file, os.F_OK)
  142.  
  143. ##
  144. # Parse a URI. Returns a tuple (protocol, username, password, host, port, path)
  145. # Returns None if URI is invalid.
  146. # @param uri URI to be parsed
  147. def parse_uri(uri):
  148.     # Compile the regex
  149.     expr = re.compile('(\w+)://(?:([^:@]+)(?::([^@]+))?@)?(?:([a-zA-Z0-9.-]+)(?::(\d+))?)?(/.*)')
  150.  
  151.     # Run it against the URI
  152.     res = expr.match(uri)
  153.  
  154.     if not res:
  155.         # URI doesn't match regex and therefore is invalid
  156.         return None
  157.  
  158.     # Get tuple of matches
  159.     # 0 - Protocol
  160.     # 1 - Username
  161.     # 2 - Password
  162.     # 3 - Host
  163.     # 4 - Port
  164.     # 5 - Path
  165.     uriparts = res.groups()
  166.     return uriparts
  167.  
  168. ##
  169. # Check to see if the string is a valid URI. Returns bool.
  170. # @param uri                 URI to be validated
  171. # @param checklocal=True    Whether to look for a local uri.
  172. def is_uri(uri, checklocal=True):
  173.     # Make sure it is a string
  174.     if not is_realstring(uri):
  175.         return False
  176.             
  177.     # Set the valid uri types
  178.     valid_uri_types = ('ftp', 'rsync', 'http', 'file', 'https', 'scp')
  179.         
  180.     # Parse the URI
  181.     uriparts = parse_uri(uri)
  182.     if not uriparts:
  183.         # Invalid URI
  184.         return False
  185.  
  186.     # Check for valid uri type
  187.     if not uriparts[0] in valid_uri_types:
  188.         return False
  189.         
  190.     # If checklocal and the URI is a local file, check to see if the file exists
  191.     if uriparts[0] == "file" and checklocal:
  192.         if not is_file(uriparts[5]):
  193.             return False
  194.         
  195.     return True
  196.  
  197. ##
  198. # Converts a string to a boolean value. anything not "True" is deemed false.
  199. # @param input  must be a string so it can be converted to boolean.
  200. def strtobool(input):
  201.     if type(input) != str:
  202.         raise GLIException("GLIUtilityError", 'fatal','strtobool',"The input must be a string!")
  203.  
  204.     if string.lower(input) == 'true':
  205.         return True
  206.     else:
  207.         return False
  208.  
  209. ##
  210. # Check to see if device is a valid ethernet device. Returns bool.
  211. # @param device  device to be checked
  212. def is_eth_device(device):
  213.     # Make sure it is a string
  214.     if not is_realstring(device):
  215.         return False
  216.  
  217.     # Old way w/ reg ex here:
  218.     # Create a regular expression to test the specified device.
  219.     #expr = re.compile('^(eth|wlan|ppp)([0-9]{1,2})(:[0-9]{1,2})?$')
  220.     # Run the match
  221.     #res = expr.match(device)
  222.     # Return True only if there are results
  223.     #return(res != None)
  224.  
  225.     status, output = spawn("/sbin/ifconfig -a | grep -e '^[A-Za-z]'| cut -d ' ' -f 1 | grep '"+ device + "'", return_output=True)
  226.     if output:
  227.         return True
  228.     return False
  229.  
  230. ##
  231. # Will return a list of devices found in ifconfig.
  232. def get_eth_devices():
  233.     status, output = spawn("/sbin/ifconfig -a | grep -e '^[A-Za-z]'| cut -d ' ' -f 1", return_output=True)
  234.     return output.split()
  235.  
  236. ##
  237. # Checks to see if device is a valid NFS device
  238. # @param device     device to be checked
  239. def is_nfs(device):
  240.     if not is_realstring(device):
  241.         return False
  242.  
  243.     colon_location = device.find(':')
  244.  
  245.     if colon_location == -1:
  246.         return False
  247.  
  248.     host = device[:colon_location]
  249.     path = device[colon_location+1:]
  250.  
  251.     return((is_ip(host) or is_hostname(host)) and is_path(path))
  252.  
  253. ##
  254. # Sets the network ip (used for the livecd environment)
  255. # @param dev         device to be configured
  256. # @param ip         ip address of device
  257. # @param broadcast     broadcast address of device
  258. # @param netmask     netmask address of device
  259. def set_ip(dev, ip, broadcast, netmask):
  260.     if not is_ip(ip) or not is_ip(netmask) or not is_ip(broadcast):
  261.         raise GLIException("GLIUtilityError", 'fatal','set_ip', ip + ", " + netmask + "and, " + broadcast + "must be a valid IP's!")
  262.     if not is_eth_device(dev):
  263.         raise GLIException("GLIUtilityError", 'fatal','set_ip', dev + "is not a valid ethernet device!")
  264.  
  265.     options = "%s inet %s broadcast %s netmask %s" % (dev, ip, broadcast, netmask)
  266.  
  267.     status = spawn("ifconfig " + options)
  268.  
  269.     if not exitsuccess(status):
  270.         return False
  271.  
  272.     return True
  273.  
  274. ##
  275. # Sets the default route (used for the livecd environment)
  276. # @param route      ip addresss of gateway.
  277. def set_default_route(route):
  278.     if not is_ip(route):
  279.         raise GLIException("GLIUtilityError", 'fatal', 'set_default_route', route + " is not an ip address!")
  280.     status = spawn("route add default gw " + route)
  281.  
  282.     if not exitsuccess(status):
  283.         return False
  284.  
  285.     return True
  286.  
  287. ##
  288. # Will run a command with various flags for the style of output and logging.
  289. # 
  290. # @param cmd                     The command to be run
  291. # @param quiet=False             Whether or not to filter output to /dev/null
  292. # @param logfile=None             if provied will log output to the given filename
  293. # @param display_on_tty8=False     will output to tty8 instead of the screen.
  294. # @param chroot=None             will run the command inside the new chroot env.
  295. # @param append_log=False         whether to start over on the logfile or append.
  296. # @param return_output=False     Returns the output along with the exit status
  297. def spawn(cmd, quiet=False, logfile=None, display_on_tty8=False, chroot=None, append_log=False, return_output=False, linecount=0, match=None, cc=None, status_message=None):
  298.     # This is a hack since spawn() can't access _logger...set to True for verbose output on console
  299.     debug = False
  300.  
  301.     if chroot:
  302.         wrapper = open(chroot+"/var/tmp/spawn.sh", "w")
  303.         wrapper.write("#!/bin/bash -l\n" + cmd + "\nexit $?\n")
  304.         wrapper.close()
  305.         cmd = "chmod a+x " + chroot + "/var/tmp/spawn.sh && chroot " + chroot + " /var/tmp/spawn.sh 2>&1"
  306.     else:
  307.         cmd += " 2>&1 "
  308.     if debug:
  309.         print "Command: " + cmd
  310.  
  311.     output = ""
  312.  
  313.     if logfile:
  314.         if append_log:
  315.             fd_logfile = open(logfile,'a')
  316.         else:
  317.             fd_logfile = open(logfile,'w')
  318.  
  319.     if display_on_tty8:
  320.         fd_tty = open('/dev/tty8','w')
  321.  
  322.     # Set initial sub-progress display
  323.     if cc:
  324.         cc.addNotification("progress", (0, status_message))
  325.  
  326.     # open a read only pipe
  327.     ro_pipe = os.popen(cmd, 'r')
  328.  
  329.     # read a line from the pipe and loop until
  330.     # pipe is empty
  331. #    data = ro_pipe.readline()
  332.     seenlines = 0
  333.     last_percent = 0
  334.  
  335.     while 1:
  336. #        data = ro_pipe.read(16384)
  337.         data = os.read(ro_pipe.fileno(), 16384)
  338.         if debug:
  339.             print "DEBUG: read some data...length " + str(len(data))
  340.         if not data:
  341.             if linecount and cc:
  342.                 if debug:
  343.                     print "DEBUG: end of stream...progress is 1"
  344.                 cc.addNotification("progress", (1, status_message))
  345.             break
  346.  
  347. #        print "DEBUG: spawn(): data is " + str(len(data)) + " bytes long"
  348.  
  349.         if logfile:
  350.             fd_logfile.write(data)
  351. #            fd_logfile.flush()
  352.  
  353.         if display_on_tty8:
  354.             fd_tty.write(data)
  355.             fd_tty.flush()
  356.  
  357.         if return_output:
  358.             output += data
  359.  
  360.         if linecount and cc:
  361.             lastpos = -1
  362.             while 1:
  363.                 lastpos = data.find("\n", lastpos + 1)
  364.                 if lastpos == -1: break
  365. #                if match:
  366. #                    if not re.match(match, uri):
  367. #                        continue
  368.                 seenlines += 1
  369.                 if debug:
  370.                     print "DEBUG: seenlines=" + str(seenlines)
  371.             percent = float(seenlines) / linecount
  372.             if debug:
  373.                 print "DEBUG: percent=" + str(percent)
  374. #            print "DEBUG: spawn(): seenlines=" + str(seenlines) + ", linecount=" + str(linecount) + ", percent=" + str(percent)
  375.             if int(percent * 100) >= (last_percent + 5):
  376.                 last_percent = int(percent * 100)
  377.                 if debug:
  378.                     print "DEBUG: setting next progress point...last_percent=" + str(last_percent)
  379.                 cc.addNotification("progress", (percent, status_message))
  380. #                print "DEBUG: spawn(): send notification " + str((percent, status_message))
  381.  
  382. #        data = ro_pipe.readline()
  383.  
  384.     # close the file descriptors
  385.     if logfile: fd_logfile.close()
  386.     if display_on_tty8: fd_tty.close()
  387.  
  388.     # close the pipe and save return value
  389.     ret = ro_pipe.close() or 0
  390.  
  391.     if return_output:
  392.         return ret, output
  393.     else:
  394.         return ret
  395.  
  396. ##
  397. # Will check the status of a spawn result to see if it did indeed return successfully.
  398. # @param status Parameter description
  399. def exitsuccess(status):
  400.     if os.WIFEXITED(status) and os.WEXITSTATUS(status) == 0:
  401.         return True
  402.     return False
  403.  
  404. ##
  405. # Will produce a bash shell with a special prompt for the installer.
  406. def spawn_bash():
  407.     os.putenv("PROMPT_COMMAND","echo \"Type 'exit' to return to the installer.\"")
  408.     status = spawn("bash")
  409.     return status
  410.  
  411. ##
  412. # Will download or copy a file/uri to a location
  413. # @param uri     uri to be fetched.
  414. # @param path     destination for the file.
  415. def get_uri(uri, path, cc=None):
  416.     uri = uri.strip()
  417.     status = 0
  418.  
  419.     if re.match('^(ftp|http(s)?)://',uri):
  420.         if cc:
  421.             status = spawn("wget --progress=dot " + uri + " -O " + path + r""" 2>&1 | sed -u -e 's:^.\+\([0-9]\+\)%.\+$:\1:' | while read line; do [ "$line" = "$tmp_lastline" ] || echo $line | grep -e '^[1-9]'; tmp_lastline=$line; done""", linecount=100, cc=cc, status_message="Fetching " + uri.split('/')[-1])
  422.         else:
  423.             status = spawn("wget --quiet " + uri + " -O " + path)
  424.     elif re.match('^rsync://', uri):
  425.         status = spawn("rsync --quiet " + uri + " " + path)
  426.     elif uri.startswith("scp://"):
  427.         # Get tuple of matches
  428.         # 0 - Protocol
  429.         # 1 - Username
  430.         # 2 - Password
  431.         # 3 - Host
  432.         # 4 - Port
  433.         # 5 - Path
  434.         uriparts = parse_uri(uri)
  435.         scpcmd = "scp "
  436.         if uriparts[4]:
  437.             scpcmd += "-P " + uriparts[4] + " "
  438.         if uriparts[1]:
  439.             scpcmd += uriparts[1] + "@"
  440.         scpcmd += uriparts[3] + ":" + uriparts[5] + " " + path
  441.         pid, child_fd = pty.fork()
  442.         if not pid:
  443.             os.execvp("scp", scpcmd.split())
  444.         else:
  445.             while 1:
  446.                 r, w, e = select.select([child_fd], [], [])
  447.                 if child_fd in r:
  448.                     try:
  449.                         data = os.read(child_fd, 1024)
  450.                     except:
  451.                         pid2, status = os.waitpid(pid, 0)
  452.                         break
  453.                     if data.endswith("assword: "):
  454.                         if uriparts[2]:
  455.                             os.write(child_fd, uriparts[2] + "\n")
  456.                         else:
  457.                             os.write(child_fd, "\n")
  458.                     elif data.endswith("Are you sure you want to continue connecting (yes/no)? "):
  459.                         os.write(child_fd, "yes\n")
  460.                 else:
  461.                     pid2, status = os.waitpid(pid, os.WNOHANG)
  462.                     if pid2:
  463.                         break
  464.  
  465.     elif re.match('^file://', uri):
  466.         r_file = uri[7:]
  467.         if os.path.isfile(r_file):
  468.             shutil.copy(r_file, path)
  469.             if not os.path.isfile(path):
  470.                 raise GLIException("GLIUtilityError", 'fatal', 'get_uri', "Cannot copy " + r_file + " to " + path)
  471.     else:
  472.         # Just in case a person forgets file://
  473.         if os.path.isfile(uri):
  474.             shutil.copy(uri, path)
  475.             if not os.path.isfile(path):
  476.                 raise GLIException("GLIUtilityError", 'fatal', 'get_uri', "Cannot copy " + r_file + " to " + path)
  477.         else:
  478.             raise GLIException("GLIUtilityError", 'fatal', 'get_uri', "File does not exist or URI is invalid!")
  479.  
  480.     if exitsuccess(status) and is_file(path):
  481.         return True
  482.     
  483.     return False
  484.  
  485. ##
  486. # Pings a host.  Used to test network connectivity.
  487. # @param host     host to be pinged.
  488. def ping(host):
  489.     host = str(host)
  490.     if not (is_hostname(host) or is_ip(host)):
  491.         return False    #invalid IP or hostname
  492.     status = spawn("ping -n -c 2 " + host)
  493.     if not exitsuccess(status):
  494.         return False
  495.     return True
  496.  
  497. ##
  498. # Pass in the eth device's number (0, 1, 2, etc).
  499. # Returns network information in a tuple.
  500. # Order is hw_addr, ip_addr, mask, bcast, route, and
  501. # whether it's up (True or False).
  502. # @param device     device to gather info from.
  503. def get_eth_info(device):
  504.     """Pass in the eth device's number (0, 1, 2, etc).
  505.     Returns network information in a tuple.
  506.     Order is hw_addr, ip_addr, mask, bcast, route, and
  507.     whether it's up (True or False).
  508.     """
  509.     
  510.     hw_addr = 'None'
  511.     ip_addr = 'None'
  512.     mask    = 'None'
  513.     bcast    = 'None'
  514.     gw      = 'None'
  515.     up      =  False
  516.     
  517.     if len(str(device)) == 1:
  518.         device = "eth" + str(device)
  519.  
  520.     if not is_eth_device(device):
  521.         raise GLIException("GLIUtilityError", 'fatal', "get_eth_info", device + " is not a valid ethernet device!")
  522.         
  523.     status, device_info = spawn("/sbin/ifconfig " + device, return_output=True)
  524.     if exitsuccess(status):
  525.         for line in device_info.splitlines():
  526.             line = line.strip()
  527.             if 'HWaddr' in line: 
  528.                 hw_addr = line.split('HWaddr',1)[1].strip()
  529.             if 'inet addr' in line:
  530.                 ip_addr = line.split('  ')[0].split(':')[1]
  531.             if 'Bcast' in line:
  532.                 bcast = line.split('  ')[1].split(':')[1]
  533.             if 'Mask' in line:
  534.                 mask = line.split('  ')[2].split(':')[1]
  535.             if line.startswith('UP'):
  536.                 up = True
  537.     else:
  538.         raise GLIException("GLIUtilityError", 'fatal', "get_eth_info", device_info)
  539.     gw = spawn(r"/sbin/route -n | grep -e '^0\.0\.0\.0' | sed -e 's:^0\.0\.0\.0 \+::' -e 's: \+.\+$::'", return_output=True)[1].strip()
  540.     
  541.     return (hw_addr, ip_addr, mask, bcast, gw, up)
  542.     
  543. ##
  544. # Will take a uri and get and unpack a tarball into the destination.
  545. # @param tarball_uri             URI of tarball
  546. # @param target_directory         destination
  547. # @param temp_directory="/tmp"     a temporary location (used for dealing with the 
  548. #                                ramdisk size limitations of the livecd env.
  549. # @param keep_permissions=False Whether or not to keep permissions (-p)
  550. def fetch_and_unpack_tarball(tarball_uri, target_directory, temp_directory="/tmp", keep_permissions=False, cc=None):
  551.     "Fetches a tarball from tarball_uri and extracts it into target_directory"
  552.  
  553.     # Get tarball info
  554.     tarball_filename = tarball_uri.split("/")[-1]
  555.  
  556.     # Get the tarball
  557.     if not get_uri(tarball_uri, temp_directory + "/" + tarball_filename, cc):
  558.         raise GLIException("GLIUtilityError", 'fatal', 'fetch_and_unpack_tarball',"Could not fetch " + tarball_uri)
  559.  
  560.     # Reset tar options
  561.     tar_options = "xv"
  562.  
  563.     # If the tarball is bzip'd
  564.     if tarball_filename.split(".")[-1] == "tbz" or  tarball_filename.split(".")[-1] == "bz2":
  565.         format_option = "j"
  566.  
  567.     # If the tarball is gzip'd
  568.     elif tarball_filename.split(".")[-1] == "tgz" or  tarball_filename.split(".")[-1] == "gz":
  569.         format_option = "z"
  570.  
  571.     tar_options += format_option
  572.  
  573.     # If we want to keep permissions
  574.     if keep_permissions:
  575.         tar_options = tar_options + "p"
  576.  
  577.     # Get number of files in tarball
  578.     tarfiles = 0
  579.     if cc:
  580.         cc.addNotification("progress", (0, "Determining the number of files in " + tarball_filename))
  581.         tarfiles = int(spawn("tar -t" + format_option + "f " + temp_directory + "/" + tarball_filename + " 2>/dev/null | wc -l", return_output=True)[1].strip())
  582.  
  583.     # Unpack the tarball
  584.     exitstatus = spawn("tar -" + tar_options + " -f " + temp_directory + "/" + tarball_filename + " -C " + target_directory, display_on_tty8=True, logfile="/tmp/compile_output.log", append_log=True, linecount=tarfiles, cc=cc, status_message="Copying filesystem, please wait") # change this to the logfile variable
  585.  
  586.     if not exitsuccess(exitstatus):
  587.         raise GLIException("GLIUtilityError", 'fatal', 'fetch_and_unpack_tarball',"Could not unpack " + tarball_uri + " to " + target_directory)
  588.  
  589. ##
  590. # OLD Will generate a random password.  Used when the livecd didn't auto-scramble the root password.
  591. # can probably be removed but is good to keep around.
  592. def generate_random_password():
  593.     s = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890$%^&*[]{}-=+_,|'\"<>:/"
  594.     s = list(s)
  595.  
  596.     for i in range(0,len(s)/2):
  597.         x = random.randint(0,len(s)-1)
  598.         y = random.randint(0,len(s)-1)
  599.         tmp = s[x]
  600.         s[x] = s[y]
  601.         s[y] = tmp
  602.  
  603.     passwd = ""
  604.     for i in range(0,random.randint(8,12)):
  605.         passwd += s[i]
  606.  
  607.     return passwd
  608.  
  609. ##
  610. # Will grab a value from a specified file after sourcing it
  611. # @param filename         file to get the value from
  612. # @param value            value to look for
  613. def get_value_from_config(filename, value):
  614.     #OLD WAY: return string.strip(commands.getoutput("source " + filename + " && echo $" + value))
  615.     status, output = spawn("source " + filename + " && echo $" + value, return_output=True)
  616.     return string.strip(output)
  617.  
  618.  
  619. ##
  620. # Will take a password and return it hashed in md5 format
  621. # @param password         the password to be hashed
  622. def hash_password(password):
  623.     salt = "$1$"
  624.     chars = "./abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
  625.     for i in range(0, 8):
  626.         salt += chars[random.randint(0, len(chars)-1)]
  627.     salt += "$"
  628.     passwd_hash = crypt.crypt(password, salt)
  629.  
  630.     return passwd_hash
  631.  
  632. ##
  633. # Returns the real name (manufacturer and model) of a network interface
  634. # @param interface Name of interface (like in ifconfig)
  635. def get_interface_realname(interface):
  636.     # TODO: rewrite with 2.4 support
  637.     if is_file("/sys/class/net/" + interface + "/device"):
  638.         return spawn("lspci | grep $(basename $(readlink /sys/class/net/" + interface + r"/device)) | sed -e 's|^.\+ Ethernet controller: ||'", return_output=True)[1].strip()
  639.     else:
  640.         return "No Information Found"
  641.  
  642. def list_stage_tarballs_from_mirror(mirror, arch, subarch):
  643.     return spawn("wget -O - " + mirror + "/releases/" + arch + "/current/stages/" + subarch + r"/ 2> /dev/null | grep 'bz2\"' | sed -e 's:^.\+href=\"\(.\+\)\".\+$:\1:i'", return_output=True)[1].strip().split("\n")
  644.  
  645. def list_subarch_from_mirror(mirror, arch):
  646.     return spawn("wget -O - " + mirror + "/releases/" + arch + r"/current/stages/ 2> /dev/null | grep folder.gif | sed -e 's:^.\+href=\"\(.\+\)\".\+$:\1:i'", return_output=True)[1].strip().split("\n")
  647.  
  648. def list_mirrors(http=True, ftp=True, rsync=True):
  649.     mirrors = []
  650.     mirrortypes = ""
  651.     if http:
  652.         mirrortypes += "http"
  653.     if ftp:
  654.         if mirrortypes:
  655.             mirrortypes += '\|'
  656.         mirrortypes += "ftp"
  657.     if rsync:
  658.         if mirrortypes:
  659.             mirrortypes += '\|'
  660.         mirrortypes += "rsync"
  661.     mirrorlist = spawn(r"wget -O - 'http://www.gentoo.org/main/en/mirrors.xml?passthru=1' 2>/dev/null | /bin/sed -ne '/^[[:space:]]\+<uri link=\"\(" + mirrortypes + r"\):\/\/[^\"]\+\">/{s/^[[:space:]]\+<uri link=\"\([^\"]\+\)\">\(.*\)<\/uri>.*$/\1|\2/;p}'", return_output=True)[1].strip().split("\n")
  662.     for mirror in mirrorlist:
  663.         mirror = mirror.strip()
  664.         mirrors.append(mirror.split("|"))
  665.     return mirrors
  666.     
  667. def generate_keymap_list():
  668.     keymap_list = []
  669.     path = "/usr/share/keymaps/i386/*"
  670.     
  671.     # find /usr/share/keymaps -iname *.map.gz -printf "%f \n"
  672.     put, get = os.popen4("find "+path+" -iname *.map.gz -printf \"%f \n\"")
  673.     for keymap in get.readlines():
  674.         # strip the last 9 chars ( .map.gz\n )
  675.         keymap.strip()
  676.         keymap = keymap[:-9]
  677.         keymap_list.append(keymap)
  678.     
  679.     # sort the keymap list
  680.     keymap_list.sort()
  681.     
  682.     return keymap_list
  683.  
  684. def generate_consolefont_list():
  685.     consolefont_list=[]
  686.     path = "/usr/share/consolefonts"
  687.     
  688.     # find /usr/share/consolefonts -iname *.gz -printf "%f \n"
  689.     put, get = os.popen4("find "+path+" -iname *.gz -printf \"%f \n\"")
  690.     for consolefont in get.readlines():
  691.         # strip the last 5 chars ( .gz\n )
  692.         consolefont.strip()
  693.         consolefont = consolefont[:-5]
  694.         
  695.         # test if its psfu or psf or fnt
  696.         # and remove it if necessary
  697.         if consolefont[-4:]== "psfu":
  698.             consolefont = consolefont[:-5]
  699.         if consolefont[-3:]== "psf":
  700.             consolefont = consolefont[:-4]
  701.         if consolefont[-3:]=="fnt":
  702.             consolefont = consolefont[:-4]
  703.             
  704.         consolefont_list.append(consolefont)
  705.             
  706.     # sort the keymap list
  707.     consolefont_list.sort()
  708.     
  709.     return consolefont_list
  710.  
  711. def generate_consoletranslation_list():
  712.     consoletranslation_list=[]
  713.     path = "/usr/share/consoletrans"
  714.     
  715.     # find /usr/share/keymaps -iname *.trans -printf "%f \n"
  716.     put, get = os.popen4("find "+path+" -iname *.trans -printf \"%f \n\"")
  717.     for consoletran in get.readlines():
  718.         # strip the last 8 chars ( .trans\n )
  719.         consoletran.strip()
  720.         consoletran = consoletran[:-8]
  721.         consoletranslation_list.append(consoletran)
  722.         
  723.     consoletranslation_list.sort()
  724.     
  725.     return consoletranslation_list
  726.  
  727. def get_global_use_flags():
  728.     use_desc = {}
  729.     f = open("/usr/portage/profiles/use.desc", "r")
  730.     for line in f:
  731.         line = line.strip()
  732.         if line == "# The following flags are NOT to be set or unset by users":
  733.             break
  734.         if not line or line.startswith("#"): continue
  735.         dash_pos = line.find(" - ")
  736.         if dash_pos == -1: continue
  737.         flagname = line[:dash_pos] or line[dash_pos-1]
  738.         desc = line[dash_pos+3:]
  739.         use_desc[flagname] = desc
  740.     f.close()
  741.     return use_desc
  742.     
  743. def get_local_use_flags():
  744.     use_local_desc = {}
  745.     f = open("/usr/portage/profiles/use.local.desc", "r")
  746.     for line in f:
  747.         line = line.strip()
  748.         if not line or line.startswith("#"): continue
  749.         dash_pos = line.find(" - ")
  750.         if dash_pos == -1: continue
  751.         colon_pos = line.find(":", 0, dash_pos)
  752.         pkg = line[:colon_pos]
  753.         flagname = line[colon_pos+1:dash_pos] or line[colon_pos+1]
  754.         desc = "(" + pkg + ") " + line[dash_pos+3:]
  755.         use_local_desc[flagname] = desc
  756.     f.close()
  757.     return use_local_desc
  758.     
  759. def get_cd_snapshot_uri():
  760.     snapshot_loc = spawn("ls /mnt/{cdrom,livecd}/snapshots/portage-* 2>/dev/null | head -n 1", return_output=True)[1].strip()
  761.     if snapshot_loc:
  762.         snapshot_loc = "file://" + snapshot_loc
  763.     return snapshot_loc
  764.  
  765. def validate_uri(uri):
  766.     # Get tuple of matches
  767.     # 0 - Protocol
  768.     # 1 - Username
  769.     # 2 - Password
  770.     # 3 - Host
  771.     # 4 - Port
  772.     # 5 - Path
  773.     uriparts = parse_uri(uri)
  774.     if not uriparts:
  775.         return False
  776.     if uriparts[0] in ('http', 'https', 'ftp'):
  777.         ret = spawn("wget --spider " + uri)
  778.         return exitsuccess(ret)
  779.     elif uriparts[0] == "file":
  780.         return is_file(uriparts[5])
  781.     return True
  782.  
  783. def get_directory_listing_from_uri(uri):
  784.     uriparts = parse_uri(uri)
  785.     if not uriparts:
  786.         return []
  787.     if uriparts[0] == "file":
  788.         dirlist = os.listdir(uriparts[5])
  789.         dirlist.sort()
  790.         dirs = []
  791.         files = []
  792.         for entry in dirlist:
  793.             if os.path.isdir(uriparts[5] + entry):
  794.                 dirs.append(entry + "/")
  795.             else:
  796.                 files.append(entry)
  797.         if not uriparts[5] == "/":
  798.             dirlist = ["../"]
  799.         else:
  800.             dirlist = []
  801.         dirlist += dirs + files
  802.     elif uriparts[0] == "http":
  803.         dirlist = spawn("wget -O - http://" + uriparts[3] + uriparts[5] + r" 2> /dev/null | grep -i href | grep -v 'http://' | grep -v 'ftp://' | sed -e 's:^.\+href=\"\(.\+\)\".\+$:\1:i'", return_output=True)[1].strip().split("\n")
  804.         dirs = []
  805.         files = []
  806.         for entry in dirlist:
  807.             if not entry.startswith("/") and entry.find("?") == -1:
  808.                 if entry.endswith("/"):
  809.                     dirs.append(entry)
  810.                 else:
  811.                     files.append(entry)
  812.         dirs.sort()
  813.         files.sort()
  814.         if not uriparts[5] == "/":
  815.             dirlist = ["../"]
  816.         else:
  817.             dirlist = []
  818.         dirlist += dirs + files
  819.     elif uriparts[0] == "ftp":
  820.         dirlist = spawn("wget -O - ftp://" + uriparts[3] + uriparts[5] + r" 2> /dev/null | grep -i href | sed -e 's:^.\+href=\"\(.\+\)\".\+$:\1:i' -e 's|^ftp://[^/]\+/|/|'", return_output=True)[1].strip().split("\n")
  821.         dirs = []
  822.         files = []
  823.         for entry in dirlist:
  824.             if entry.startswith(uriparts[5]):
  825.                 entry = entry[len(uriparts[5]):]
  826.                 if entry.endswith("/"):
  827.                     dirs.append(entry)
  828.                 else:
  829.                     files.append(entry)
  830.         dirs.sort()
  831.         files.sort()
  832.         if not uriparts[5] == "/":
  833.             dirlist = ["../"]
  834.         else:
  835.             dirlist = []
  836.         dirlist += dirs + files
  837.     elif uriparts[0] == "scp":
  838.         tmpdirlist = ""
  839.         dirlist = []
  840.         sshcmd = ["ssh"]
  841.         if uriparts[4]:
  842.             sshcmd.append("-p")
  843.             sshcmd.append(uriparts[4])
  844.         if uriparts[1]:
  845.             sshcmd.append(uriparts[1] + "@" + uriparts[3])
  846.         else:
  847.             sshcmd.append(uriparts[3])
  848.         sshcmd.append("ls --color=no -1F " + uriparts[5] + r" 2>/dev/null | sed -e 's:\*$::'")
  849. #        print str(sshcmd)
  850.         pid, child_fd = pty.fork()
  851.         if not pid:
  852.             os.execvp("ssh", sshcmd)
  853.         else:
  854.             got_password_prompt = False
  855.             while 1:
  856.                 r, w, e = select.select([child_fd], [], [])
  857.                 if child_fd in r:
  858.                     try:
  859.                         data = os.read(child_fd, 1024)
  860.                     except:
  861.                         pid2, status = os.waitpid(pid, 0)
  862.                         break
  863.                     if data.endswith("assword: "):
  864.                         if uriparts[2]:
  865.                             os.write(child_fd, uriparts[2] + "\n")
  866.                         else:
  867.                             os.write(child_fd, "\n")
  868.                         got_password_prompt = True
  869.                     elif data.endswith("Are you sure you want to continue connecting (yes/no)? "):
  870.                         os.write(child_fd, "yes\n")
  871.                     else:
  872.                         if got_password_prompt:
  873.                             if not tmpdirlist and data.endswith("assword: "):
  874.                                 raise GLIException("IncorrectPassword", "notice", "get_directory_listing_from_uri", "Your SSH password was incorrect")
  875.                             tmpdirlist += data
  876.                 else:
  877.                     pid2, status = os.waitpid(pid, os.WNOHANG)
  878.                     if pid2:
  879.                         break
  880.         for tmpentry in tmpdirlist.strip().split("\n"):
  881.             dirlist.append(tmpentry.strip())
  882.         dirs = []
  883.         files = []
  884.         for entry in dirlist:
  885.             if entry.endswith("/"):
  886.                 dirs.append(entry)
  887.             else:
  888.                 files.append(entry)
  889.         dirs.sort()
  890.         files.sort()
  891.         if not uriparts[5] == "/":
  892.             dirlist = ["../"]
  893.         else:
  894.             dirlist = []
  895.         dirlist += dirs + files
  896.     else:
  897.         dirlist = ["this/", "type/", "isn't/", "supported", "yet"]
  898.     return dirlist
  899.  
  900. def cdata(text):
  901.     if text.startswith("<![CDATA["):
  902.         return text
  903.     else:
  904.         return "<![CDATA[\n" + text + "\n]]>"
  905.  
  906. def uncdata(text):
  907.     if text.startswith("<![CDATA["):
  908.         return text[9:-5]
  909.     else:
  910.         return text
  911.         
  912. def get_grp_pkgs_from_cd():
  913.     if not is_file("/usr/livecd/grppkgs.txt"):
  914.         return ""
  915.         #raise GLIException("GLIUtilityError", "fatal", "get_grp_pkgs_from_cd", "Required file /usr/livecd/grppkgs.txt does not exist")
  916.     status,output = spawn('cat /usr/livecd/grppkgs.txt',return_output=True)
  917.     output = output.split()
  918.     #remove the first part before a / for comparision
  919.     results = []
  920.     for pkg in output:
  921.         results.append(pkg[(pkg.find('/')+1):])
  922.     return results
  923.  
  924. def get_keymaps(self):
  925.     return GLIUtility.spawn(r"find /usr/share/keymaps -iname *.map.gz | sed -e 's:^.\+/::' -e 's:\..\+$::' | sort", return_output=True)[1].strip().split("\n")
  926.  
  927. def get_chosts(arch):
  928.     chosts = []
  929.     if arch == "x86":
  930.         chosts = ["i386-pc-linux-gnu", "i486-pc-linux-gnu", "i586-pc-linux-gnu", "i686-pc-linux-gnu"]
  931.     if arch == "amd64":
  932.         chosts = ["x86_64-pc-linux-gnu"]
  933.     if arch == "alpha":
  934.         chosts = ["alpha-unknown-linux-gnu"]
  935.     if arch == "ppc":
  936.         chosts = ["powerpc-unknown-linux-gnu"]
  937.     if arch == "ppc64":
  938.         chosts = ["powerpc64-unknown-linux-gnu"]
  939.     if arch in ["sparc", "sparc64"]:
  940.         chosts = ["sparc-unknown-linux-gnu"]
  941.     if arch == "hppa":
  942.         chosts = ["hppa-unknown-linux-gnu", "hppa1.1-unknown-linux-gnu", "hppa2.0-unknown-linux-gnu"]
  943.     if arch == "mips":
  944.         chosts = ["mips-unknown-linux-gnu"]
  945.     return chosts
  946.